.TH lha_stopnode 1 "18 April 2012" "TrueCL Commands"

.SH NAME
lha_stopnode \- Take a Node out of running Cluster

.SH SYNOPSES
.TS
l l.
lha_stopnode	[\fB-N|--node\fP \fIX\fP] [\fB-A|--leave-apps\fP|\fB--abort\fP] [\fB--timeout\fP \fIN\fP]
	[\fB--force\fP] [\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP]
	[\fB--lwidth\fP \fIN\fP]
.TE

.SH DESCRIPTION
The \fIlha_stopnode(1)\fP command is used to remove a node from the currently
running cluster configuration. Commonly such a utility is used to perform offline 
software upgrades or hardware changes for example.

Depending on the arguments used this action may or may not immediately impact
any applications currently running on this cluster node. The default action to
take if applications are running is to abort this node removal rahter than
causing any application availability issues.

If no node is specified on the command line it is assumed the node on which
the command is being executed is the node to remove from the cluster.

.SH ARGUMENTS
.TP 8
--node
Indicates the node that is to be removed from the cluster. If not specified it
will instead remove the current node from the cluster.

.TP
--abort
If the node is currently hosting one or more applications as part of the
cluster then stop these applications prior to removing the node from the
cluster.
.TP
--leave-apps
Any applications currently running on the node are left running even though 
cluster services on this node stop. This means any applications will continue
to function, but all software/hardware monitoring stops. Hence if the node
dies or software processes failure no actions will take place.

This function is most often useful when performing upgrades to TrueCL that
deem an "offline" software upgrade is necessary.

.TP
--timeout
The amount of time to wait for certain responses to requests that are 
necessary for the node to be stopped.  If this is not specified the
value is taken as 10 seconds. 

.TP
--debug
Run the node removal in 'debug' mode - might produce significant levels 
of output to the standard output device, most of which is only useful for
developers.

.TP
--verbose
Verbose mode generates a sensible amount of output to standard output to 
show the progress of application shutdown. This is the recommended flag if
the administrator wishes to see any output.
.TP
--quiet
This will only produce errors and warnings on the standard output device.
.TP
--silent
Only produce output if fatal errors occurs during attempted shutdown of the 
application.

.SH OUTPUT
In verbose mode the utility will show the removal of the node from the 
cluster. If applications are being stopped then the output from 
running the stop of the application will also be shown at the same
level of verbosity.

.SH EXIT CODES
If the node is successfulky removed from the cluster then 0 (success) will
be returned. Any non-zero value indicates a failure to complete the
requested node removal from the clusstopped as expected, a return code of '0' will be given, 
indicating success. Otherwise a failure is indicated with a return code of '1'.

.SH FILES
The utility uses standard error and output for all messages. When the 
application shutdown occurs, the following log files are used for
any output generated by the scripts:

.TS
l l.
stopapp-APP-TIME.log	Application "APP" shutdown at time "TIME" log.
stopapp-APP-TIME.stdout	Application standard output.
stopapp-APP-TIME.stderr	Application standard error.
.TE

.SH NOTES
The time taken for this action to complete is highly dependent on the arguments
specified and how many applications are currently running on the node.

A speedy way to run is to use \fB--leave-apps\fP since it does not require
any change in application state.

.SH AUTHOR
The TrueCL software was written by Simon Edwards, (C) 2006-2012, working
for Advantsys Computer Services Ltd - www.advantsys.co.uk.

.SH SEE ALSO
.BR lha_startapp(1),
.BR lha_stopapp(1).
.BR lha_form(1).

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP. For
more information, please see the following page: truecl.advantsys.co.uk.

